Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add more clear and description comments #53

Merged
merged 9 commits into from
Oct 15, 2021
Merged

docs: add more clear and description comments #53

merged 9 commits into from
Oct 15, 2021

Conversation

jaybxyz
Copy link
Contributor

@jaybxyz jaybxyz commented Oct 6, 2021 •
edited by dongsam
Loading

Description

closes: #51

Tasks

  • scan through client folder to improve comments
  • scan through keeper folder to improve comments
  • scan through simulation folder to improve comments (work will be done in test: randomize simulations for edge cases #32)
  • scan through types folder to improve comments
  • Make proto-all, Update published swagger on swaggerHub

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Appropriate labels applied
  • Targeted PR against correct branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

@jaybxyz jaybxyz self-assigned this Oct 6, 2021
@jaybxyz
Copy link
Contributor Author

jaybxyz commented Oct 8, 2021 •
edited
Loading

@hallazzang I added/updated comments in both keeper and types packages. Can you review those whenever you can? There is TODO comment in BudgetCollection of keeper/budget.go and I am not sure if that is already done so I leave it there.

hallazzang
hallazzang suggested changes Oct 14, 2021
View reviewed changes
x/budget/keeper/budget.go Show resolved Hide resolved
x/budget/types/budget.go Outdated Show resolved Hide resolved
@jaybxyz
Merge commit '3bc1decf7cc852747e275db20404446c69d4ede9' into kogisin/…
b63ca95 
…51-refactor-comments

* commit '3bc1decf7cc852747e275db20404446c69d4ede9':
  chore: bump Cosmos SDK version to 0.44.2
  test: update simulation tests (tendermint#54)
@jaybxyz
chore: rename BudgetCollection to CollectBudgets and update relevant …
7096d23 
…docs
@jaybxyz
refactor: apply suggestion
54c3153
@jaybxyz jaybxyz marked this pull request as ready for review October 14, 2021 09:37
dongsam
dongsam approved these changes Oct 15, 2021
View reviewed changes
Copy link
Contributor

@dongsam dongsam left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM,

but It seems like proto-format proto-lint proto-gen was not executed well.
This can happen if the proto docker container for another module collides even if the make is executed. let me commit this.

and Swagger was updated through this PR. The API specification is not changed but description, etc., so it is not necessary to upgrade the swagger version, but if there is a change from next time, it would be good to upgrade the swagger version from client/docs/config.json, re-generate it, and update it with the swagger hub.

@dongsam dongsam merged commit a9a10d3 into tendermint:master Oct 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dongsam dongsam dongsam approved these changes

@hallazzang hallazzang hallazzang approved these changes

Assignees

@jaybxyz jaybxyz

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: add clear and more descriptive comments
3 participants
@jaybxyz @dongsam @hallazzang